home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / qbbs / raaddlog.zip / RAADDLOG.DOC next >
Text File  |  1990-05-04  |  9KB  |  212 lines
  1.                                                                      
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.                           [*]   RAAddLog    [*]
  10.  
  11.                               Version  1.02
  12.  
  13.                    (C) Copyright 1990, By Randall Edwards 
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.                                DISCLAIMER 
  23.                                ----------
  24.  
  25.               The program RAADDLOG.EXE and this documentation are the
  26.          copyrighted property of Randall Edwards. All rights, except 
  27.          those outlined in this document, are reserved. 
  28.  
  29.               By using this software you acknowledge that this 
  30.          software may not suit your particular needs or be completely 
  31.          trouble free.  Use this program at your own risk. 
  32.  
  33.               In no event will Randall Edwards be liable for any 
  34.          damages, including any lost profits, lost savings or other 
  35.          incidental or consequential damages arising out of the use of 
  36.          or inability to use these programs, even if Randall Edwards 
  37.          has been advised of the possibility of such damages. 
  38.  
  39.               In short, there's absolutely no guarantees with this 
  40.          program.  Use it at your own risk.  If you break it, you can 
  41.          have both pieces. 
  42.  
  43.  
  44.  
  45.                           CREDIT WHERE CREDIT IS DUE 
  46.                           ---------------------------
  47.  
  48.               Thanks to the authors of RemoteAccess for writing such a 
  49.          fine bulletin board system for which this utility is intended 
  50.          to be used with. 
  51.  
  52.               Thanks to Fabrice Bellard, of Grabels France, for his 
  53.          fine utility LZEXE which was used to compress the final .EXE 
  54.          file and resulted in a significant, over 36%, savings in disk
  55.          space in the final distributed .EXE file.
  56.  
  57.               I give credit to the Taiwanese, who for near-slave wages 
  58.          produced this computer that this program was written on.  By 
  59.          allowing companies based in the United States to steal their 
  60.          labor and the profits from their hard work, I have the wealth 
  61.          and time to 'play' around with this machine and to write 
  62.          programs like this.  They have only their near-slave wages, 
  63.          terrible working conditions, and my appreciation and hope 
  64.          that they can overcome obstacles in their way and achieve 
  65.          full social justice. 
  66.          
  67.  
  68.  
  69.                              PURPOSE AND USAGE 
  70.                              -----------------
  71.          
  72.               RAAddLog is a simple program to add a formatted log entry
  73.          into your RemoteAccess system log.  This is handy for adding 
  74.          log entries while in your batch file doing maintenance or 
  75.          while running door programs to keep track of when a user did 
  76.          this or that.  For instance I also use it to log when my
  77.          system reboots or runs AutoExec.Bat.  You'll probably think
  78.          of many uses for it.
  79.          
  80.               The program usage is simple.  Whatever you specify on 
  81.          the program's DOS command line is included into the system 
  82.          log.  Let's take an example:
  83.          
  84.          C> RAAddLog Doing system maintenance.
  85.          
  86.               This would enter the message "Doing system maintenance."
  87.          into your system log formatted with the appropriate time and
  88.          date entries.
  89.  
  90.               For example, with the Opus style of logging it would
  91.          produce something like:
  92.  
  93.          + 7-Apr 21:22:23 LOG! Doing system maintenance.
  94.  
  95.          or with the FrontDoor syle of logging, something like:
  96.  
  97.          ----------  Sat 7 Apr 90, RAAddLog
  98.          + 21:22:23  Doing system maintenance.
  99.          
  100.               If you don't specify anything on the DOS command line, 
  101.          then you'll be prompted with a short help screen telling you 
  102.          that you need to run it with something on the DOS command 
  103.          line.  Simple huh?
  104.          
  105.               I hope you find it useful.  If you have any suggestions,
  106.          comments, or <eek!> bug reports, please send them to Randy
  107.          Edwards at the Socialism OnLine! BBS (203) 274-4639; 300 -
  108.          14.4k HST at FidoNet 1:141/552 or at Good Egg Net 99:9300/552.
  109.          
  110.  
  111.  
  112.          TECHNICAL NOTES:
  113.          ----------------
  114.          
  115.               Well, if you could call a program as simple as this 
  116.          technical, these would be the notes. <grin> 
  117.          
  118.               The program uses redirectable screen writes so you won't 
  119.          have to worry about it messing up your screen if you're 
  120.          running a multi-tasking system.
  121.  
  122.               The program returns two errorlevels: zero or one.  If 
  123.          the program ends normally with no errors it will return a DOS 
  124.          errorlevel of 0.  If it has any errors it will return a DOS 
  125.          errorlevel of 1.
  126.  
  127.               The program outputs to the screen whether it is actually
  128.          creating a new log file, according to what you specified in
  129.          your CONFIG.RA file, or if it is appending to an existing log
  130.          file.
  131.  
  132.               RAAddLog must be able to find the CONFIG.RA file.  First
  133.          it looks for it in the current subdirectory.  If it can't find
  134.          it in the current subdirectory it then reads the RA environment
  135.          variable to locate CONFIG.RA.  If it can't find it using the RA
  136.          environment variable (or if the environment variable is not set)
  137.          it will then abort with a DOS errorlevel of 1.
  138.          
  139.               RAAddLog reads CONFIG.RA and gets the type of log you have
  140.          selected, either Opus-type or FrontDoor-type and it also gets 
  141.          the location of your log file from CONFIG.RA.  Then RAAddLog
  142.          uses the appropriate log format (either Opus or FrontDoor) to 
  143.          write out information into the log file.
  144.  
  145.               RAAddLog is dependent on the version of CONFIG.RA it
  146.          reads to be sure it is getting the proper format.  If it finds
  147.          a version of CONFIG.RA that it doesn't know how to read, it
  148.          will abort with a DOS errorlevel of 1.
  149.  
  150.               As noted in the credits, the .EXE file was compressed 
  151.          with Fabrice Bellard's LZEXE program, which resulted in a 
  152.          more than one-third savings in disk space for the final
  153.          distributed RAADDLOG.EXE file.
  154.  
  155.  
  156.  
  157.           VERSION HISTORY 
  158.           ---------------
  159.  
  160.          1.02 - Minor changes in the way RAAddLog finds Config.Ra.
  161.                    First, RAAddLog looks in the current subdirectory
  162.                    for a copy of Config.Ra.  If it finds one, it uses
  163.                    it.  If it does not find on in the current subdir,
  164.                    then the program attempts to read the RA environment
  165.                    variable to find Config.Ra - if if finds it using
  166.                    the environment variable fine, if not it aborts.
  167.  
  168.                 RAAddLog now checks the Config.Ra file to ensure that
  169.                    it is running on the proper version of RA.  This
  170.                    version of RAAddLog will run on RA versions 0.01 to
  171.                    0.03 and will abort if you attempt to run it on
  172.                    other versions.
  173.  
  174.          1.01 - Minor maintenance release in preparation to releasing
  175.                    the program through the SDS.
  176.  
  177.                 Name changed from RALOG in version 1, to RAADDLOG in
  178.                    version 1.01.  This was done to make the name more
  179.                    unique and to reflect its actual function better.
  180.  
  181.                 Changed code to add the program name (RAAddLog) when
  182.                    outputting a log entry into a FrontDoor-style log
  183.                    format.  This should be entirely compatible with
  184.                    the standard FrontDoor logging format.  (Opus log
  185.                    format is unchanged.)
  186.  
  187.                 Minor code cleanup and cosmetic changes.
  188.           
  189.          1.0 - Initial public release. 
  190.  
  191.  
  192.  
  193.                                 LICENSE 
  194.                                 -------
  195.          
  196.               It's free.  If you like it use it.  If you don't like it 
  197.          then erase it from your disk(s) and forget all about it.  
  198.          
  199.               The only persons and/or organizations that are 
  200.          specifically forbidden to use this program are anyone 
  201.          employed by the Department of Defense and/or the National 
  202.          Security Agency of the United States Government or those
  203.          actual government organizations; and/or any citizen of the
  204.          Republic of South Africa for as long as the racist
  205.          apartheid regime there is still in power.
  206.          
  207.               All trademarks mentioned in this documented are
  208.          probably registered to their respective owners.
  209.  
  210.  
  211.  
  212.